Add field maturity and remove experimental pipeline#2599
Add field maturity and remove experimental pipeline#2599kgeller merged 5 commits intoelastic:mainfrom
Conversation
🤖 GitHub commentsExpand to view the GitHub comments
Just comment with:
|
|
Documentation changes preview: https://docs-v3-preview.elastic.dev/elastic/ecs/pull/2599/reference/ |
Co-authored-by: Alexandra Konrad <alexandra.konrad@elastic.co>
Vale Linting ResultsSummary: 1 suggestion found 💡 Suggestions (1)
The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
|
one thing that came to my mind - in our docs we don’t have a prominent beta (or alpha) sign, we only have Maybe we should add a tag similar to what we do for otel such as related? and put it near the name so that person see at once the maturity status. Or even use a new column for maturity. wdyt? |
@trisch-me we can consult with the docs team on this as a followup? It definitely sounds nice to make it clearer, but I think it would be great to get their take on it to make sure we can match existing / define the convention |
|
sure, do you know who is contact person for this? :) |
I'm not sure, my plan was to post in their slack channel 😄 |
3 participants
Summary
alphaas a first-class schema attribute mirroringbeta(validation, reuse propagation, doc rendering), with mutual exclusion enforcedexperimental/build pipeline, directory, and unusedcgroup.*fields — zero adoption,container.*already covers the use caseecs-principles-design.mdschemas/README.md,USAGE.md, and internal developer docsThis is the first of three PRs: (1) alpha maturity + remove experimental, (2) streamline RFC process, (3) annotate in-flight RFCs.
Test plan
make test— 153 tests passmake generate— clean build, no diffexperimentalreferences in.py,.yml,.j2, orMakefiledevice) renders correctly — no regressionalphatoagent.version, confirmed italic marker renders in generated docs, then reverted